<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<meta name="generator" content="Doxygen 1.8.3"/>
<title>Open Data Protection C API: src/odpapi.c File Reference</title>
<link href="../../tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="../../jquery.js"></script>
<script type="text/javascript" src="../../dynsections.js"></script>
<link href="../../search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="../../search/search.js"></script>
<script type="text/javascript">
  $(document).ready(function() { searchBox.OnSelectItem(0); });
</script>
<link href="../../doxygen.css" rel="stylesheet" type="text/css" />
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
 <tbody>
 <tr style="height: 56px;">
  <td style="padding-left: 0.5em;">
   <div id="projectname">Open Data Protection C API
   &#160;<span id="projectnumber">10</span>
   </div>
  </td>
 </tr>
 </tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.3 -->
<script type="text/javascript">
var searchBox = new SearchBox("searchBox", "../../search",false,'Search');
</script>
  <div id="navrow1" class="tabs">
    <ul class="tablist">
      <li><a href="../../index.html"><span>Main&#160;Page</span></a></li>
      <li><a href="../../pages.html"><span>Related&#160;Pages</span></a></li>
      <li><a href="../../annotated.html"><span>Data&#160;Structures</span></a></li>
      <li class="current"><a href="../../files.html"><span>Files</span></a></li>
      <li>
        <div id="MSearchBox" class="MSearchBoxInactive">
        <span class="left">
          <img id="MSearchSelect" src="../../search/mag_sel.png"
               onmouseover="return searchBox.OnSearchSelectShow()"
               onmouseout="return searchBox.OnSearchSelectHide()"
               alt=""/>
          <input type="text" id="MSearchField" value="Search" accesskey="S"
               onfocus="searchBox.OnSearchFieldFocus(true)" 
               onblur="searchBox.OnSearchFieldFocus(false)" 
               onkeyup="searchBox.OnSearchFieldChange(event)"/>
          </span><span class="right">
            <a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="../../search/close.png" alt=""/></a>
          </span>
        </div>
      </li>
    </ul>
  </div>
  <div id="navrow2" class="tabs2">
    <ul class="tablist">
      <li><a href="../../files.html"><span>File&#160;List</span></a></li>
      <li><a href="../../globals.html"><span>Globals</span></a></li>
    </ul>
  </div>
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
     onmouseover="return searchBox.OnSearchSelectShow()"
     onmouseout="return searchBox.OnSearchSelectHide()"
     onkeydown="return searchBox.OnSearchSelectKey(event)">
<a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(0)"><span class="SelectionMark">&#160;</span>All</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(1)"><span class="SelectionMark">&#160;</span>Data Structures</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(2)"><span class="SelectionMark">&#160;</span>Files</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(3)"><span class="SelectionMark">&#160;</span>Functions</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(4)"><span class="SelectionMark">&#160;</span>Variables</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(5)"><span class="SelectionMark">&#160;</span>Typedefs</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(6)"><span class="SelectionMark">&#160;</span>Enumerations</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(7)"><span class="SelectionMark">&#160;</span>Enumerator</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(8)"><span class="SelectionMark">&#160;</span>Macros</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(9)"><span class="SelectionMark">&#160;</span>Pages</a></div>

<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<iframe src="javascript:void(0)" frameborder="0" 
        name="MSearchResults" id="MSearchResults">
</iframe>
</div>

<div id="nav-path" class="navpath">
  <ul>
<li class="navelem"><a class="el" href="../../dir_68267d1309a1af8e8297ef4c3efbcdba.html">src</a></li>  </ul>
</div>
</div><!-- top -->
<div class="header">
  <div class="summary">
<a href="#define-members">Macros</a> &#124;
<a href="#func-members">Functions</a>  </div>
  <div class="headertitle">
<div class="title">odpapi.c File Reference</div>  </div>
</div><!--header-->
<div class="contents">
<div class="textblock"><code>#include &lt;<a class="el" href="../../d0/d70/odpapi_8h_source.html">odpapi.h</a>&gt;</code><br/>
<code>#include &lt;string.h&gt;</code><br/>
<code>#include &lt;stdio.h&gt;</code><br/>
<code>#include &lt;<a class="el" href="../../d1/d82/cJSON_8h_source.html">cjson.h</a>&gt;</code><br/>
<code>#include &lt;time.h&gt;</code><br/>
</div><div class="textblock"><div class="dynheader">
Include dependency graph for odpapi.c:</div>
<div class="dyncontent">
<div class="center"><img src="../../d8/d79/odpapi_8c__incl.png" border="0" usemap="#src_2odpapi_8c" alt=""/></div>
<map name="src_2odpapi_8c" id="src_2odpapi_8c">
<area shape="rect" id="node2" href="../../d0/d70/odpapi_8h.html" title="Open Data Protection API Helper Header." alt="" coords="5,80,75,107"/></map>
</div>
</div>
<p><a href="../../d8/d4f/odpapi_8c_source.html">Go to the source code of this file.</a></p>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="define-members"></a>
Macros</h2></td></tr>
<tr class="memitem:a5600ecac2c2f3c40cf48bfcfd6e146ac"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="../../d8/d4f/odpapi_8c.html#a5600ecac2c2f3c40cf48bfcfd6e146ac">ODPAPI_VERSION</a>&#160;&#160;&#160;&quot;1.0&quot;</td></tr>
<tr class="separator:a5600ecac2c2f3c40cf48bfcfd6e146ac"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="func-members"></a>
Functions</h2></td></tr>
<tr class="memitem:a8debbd76bf22a3ce3b7b2d865abed648"><td class="memItemLeft" align="right" valign="top">char *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="../../d8/d4f/odpapi_8c.html#a8debbd76bf22a3ce3b7b2d865abed648">odpapi_format_common_result_text</a> (char *buffer, size_t length, enum <a class="el" href="../../d0/d70/odpapi_8h.html#a173a55e8071a19a0345ead2067182a87">ODPAPI_COMMONERROR</a> error)</td></tr>
<tr class="memdesc:a8debbd76bf22a3ce3b7b2d865abed648"><td class="mdescLeft">&#160;</td><td class="mdescRight">Returns a text representation for a given common error enumeration.  <a href="#a8debbd76bf22a3ce3b7b2d865abed648"></a><br/></td></tr>
<tr class="separator:a8debbd76bf22a3ce3b7b2d865abed648"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a41d9d125419e40138d3573c62e9892a7"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="../../d8/d4f/odpapi_8c.html#a41d9d125419e40138d3573c62e9892a7">odpapi_response_epilog</a> (<a class="el" href="../../db/d68/structcJSON.html">cJSON</a> *root, enum <a class="el" href="../../d0/d70/odpapi_8h.html#a173a55e8071a19a0345ead2067182a87">ODPAPI_COMMONERROR</a> error, char *hint)</td></tr>
<tr class="memdesc:a41d9d125419e40138d3573c62e9892a7"><td class="mdescLeft">&#160;</td><td class="mdescRight">Sets the response section with an integer and string representation of the ODPAPI function result.  <a href="#a41d9d125419e40138d3573c62e9892a7"></a><br/></td></tr>
<tr class="separator:a41d9d125419e40138d3573c62e9892a7"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aed8e60a1ba06717416d5141af6ad2bc5"><td class="memItemLeft" align="right" valign="top"><a class="el" href="../../db/d68/structcJSON.html">cJSON</a> *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="../../d8/d4f/odpapi_8c.html#aed8e60a1ba06717416d5141af6ad2bc5">odpapi_response_prolog</a> (<a class="el" href="../../db/d68/structcJSON.html">cJSON</a> *root, char *adaptername)</td></tr>
<tr class="memdesc:aed8e60a1ba06717416d5141af6ad2bc5"><td class="mdescLeft">&#160;</td><td class="mdescRight">Initializes <a class="el" href="../../db/d68/structcJSON.html">cJSON</a> control area with meta and response sections.  <a href="#aed8e60a1ba06717416d5141af6ad2bc5"></a><br/></td></tr>
<tr class="separator:aed8e60a1ba06717416d5141af6ad2bc5"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aae7c9c555eb8f8005d5a4432c5066194"><td class="memItemLeft" align="right" valign="top"><a class="el" href="../../db/d68/structcJSON.html">cJSON</a> *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="../../d8/d4f/odpapi_8c.html#aae7c9c555eb8f8005d5a4432c5066194">odpapi_request_get_request</a> (<a class="el" href="../../db/d68/structcJSON.html">cJSON</a> *root)</td></tr>
<tr class="memdesc:aae7c9c555eb8f8005d5a4432c5066194"><td class="mdescLeft">&#160;</td><td class="mdescRight">Finds the request section.  <a href="#aae7c9c555eb8f8005d5a4432c5066194"></a><br/></td></tr>
<tr class="separator:aae7c9c555eb8f8005d5a4432c5066194"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:abfb18eac7f57290fe16965746202459e"><td class="memItemLeft" align="right" valign="top"><a class="el" href="../../db/d68/structcJSON.html">cJSON</a> *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="../../d8/d4f/odpapi_8c.html#abfb18eac7f57290fe16965746202459e">odpapi_request_get_value</a> (<a class="el" href="../../db/d68/structcJSON.html">cJSON</a> *json, char *key)</td></tr>
<tr class="memdesc:abfb18eac7f57290fe16965746202459e"><td class="mdescLeft">&#160;</td><td class="mdescRight">Locates a <a class="el" href="../../db/d68/structcJSON.html">cJSON</a> element for a given key.  <a href="#abfb18eac7f57290fe16965746202459e"></a><br/></td></tr>
<tr class="separator:abfb18eac7f57290fe16965746202459e"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a403fda3fa007514b66a723a747a743d4"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="../../d8/d4f/odpapi_8c.html#a403fda3fa007514b66a723a747a743d4">odpapi_move_response_helper</a> (<a class="el" href="../../db/d68/structcJSON.html">cJSON</a> *responsearray, enum <a class="el" href="../../d0/d70/odpapi_8h.html#a5df3e431080bf9fa4ff8a1f5ec2d2746">ODPAPI_MOVESTATUS</a> status, int sequence, char *id, char *type, char *movedate, char *hint)</td></tr>
<tr class="memdesc:a403fda3fa007514b66a723a747a743d4"><td class="mdescLeft">&#160;</td><td class="mdescRight">Creates a Move Response Element.  <a href="#a403fda3fa007514b66a723a747a743d4"></a><br/></td></tr>
<tr class="separator:a403fda3fa007514b66a723a747a743d4"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a00ee9474cd43f8889035a3d3289614ee"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="../../d8/d4f/odpapi_8c.html#a00ee9474cd43f8889035a3d3289614ee">odpapi_inventory_response_helper</a> (<a class="el" href="../../db/d68/structcJSON.html">cJSON</a> *responsearray, enum <a class="el" href="../../d0/d70/odpapi_8h.html#a0dba2207de5e8ecc9baa3a071e12a622">ODPAPI_INVENTORYSTATUS</a> status, int sequence, char *id, char *type, char *description, char *movedate, int encrypted, int scratch, int automatemovedate)</td></tr>
<tr class="memdesc:a00ee9474cd43f8889035a3d3289614ee"><td class="mdescLeft">&#160;</td><td class="mdescRight">Creates an Inventory Response Element.  <a href="#a00ee9474cd43f8889035a3d3289614ee"></a><br/></td></tr>
<tr class="separator:a00ee9474cd43f8889035a3d3289614ee"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:affbcad7cbfaba6d69f9943af2ef06a0d"><td class="memItemLeft" align="right" valign="top"><a class="el" href="../../db/d68/structcJSON.html">cJSON</a> *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="../../d8/d4f/odpapi_8c.html#affbcad7cbfaba6d69f9943af2ef06a0d">odpapi_list_response_helper</a> (<a class="el" href="../../db/d68/structcJSON.html">cJSON</a> *responsearray, int sequence, char *description, char *guid, unsigned int capacity, unsigned int capacityused, unsigned int movingin, unsigned int movingout, int automatemovedate, char **targetguids)</td></tr>
<tr class="memdesc:affbcad7cbfaba6d69f9943af2ef06a0d"><td class="mdescLeft">&#160;</td><td class="mdescRight">Creates a Library List Response Element.  <a href="#affbcad7cbfaba6d69f9943af2ef06a0d"></a><br/></td></tr>
<tr class="separator:affbcad7cbfaba6d69f9943af2ef06a0d"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a1ceaab717a211f5c24ddc9f27ddc8987"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="../../d8/d4f/odpapi_8c.html#a1ceaab717a211f5c24ddc9f27ddc8987">odpapi_scan_response_helper</a> (<a class="el" href="../../db/d68/structcJSON.html">cJSON</a> *responsearray, enum <a class="el" href="../../d0/d70/odpapi_8h.html#ac158a19a0076dd0108f469e245af0dc2">ODPAPI_SCANSTATUS</a> status, int sequence, char *id, char *type, char *hint)</td></tr>
<tr class="memdesc:a1ceaab717a211f5c24ddc9f27ddc8987"><td class="mdescLeft">&#160;</td><td class="mdescRight">Creates a Scan Response Element.  <a href="#a1ceaab717a211f5c24ddc9f27ddc8987"></a><br/></td></tr>
<tr class="separator:a1ceaab717a211f5c24ddc9f27ddc8987"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a67aecd120044b4d19aaa28d4be821a01"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="../../d8/d4f/odpapi_8c.html#a67aecd120044b4d19aaa28d4be821a01">odpapi_add_response_helper</a> (<a class="el" href="../../db/d68/structcJSON.html">cJSON</a> *responsearray, enum <a class="el" href="../../d0/d70/odpapi_8h.html#a0ef5ef162d0b77c52b4f3c17d5b769b2">ODPAPI_ADDSTATUS</a> status, int sequence, char *id, char *hint)</td></tr>
<tr class="memdesc:a67aecd120044b4d19aaa28d4be821a01"><td class="mdescLeft">&#160;</td><td class="mdescRight">Creates an Add Response Element.  <a href="#a67aecd120044b4d19aaa28d4be821a01"></a><br/></td></tr>
<tr class="separator:a67aecd120044b4d19aaa28d4be821a01"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<h2 class="groupheader">Macro Definition Documentation</h2>
<a class="anchor" id="a5600ecac2c2f3c40cf48bfcfd6e146ac"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">#define ODPAPI_VERSION&#160;&#160;&#160;&quot;1.0&quot;</td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Definition at line <a class="el" href="../../d8/d4f/odpapi_8c_source.html#l00007">7</a> of file <a class="el" href="../../d8/d4f/odpapi_8c_source.html">odpapi.c</a>.</p>

<p>Referenced by <a class="el" href="../../d8/d4f/odpapi_8c_source.html#l00130">odpapi_response_prolog()</a>.</p>

</div>
</div>
<h2 class="groupheader">Function Documentation</h2>
<a class="anchor" id="a67aecd120044b4d19aaa28d4be821a01"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void odpapi_add_response_helper </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="../../db/d68/structcJSON.html">cJSON</a> *&#160;</td>
          <td class="paramname"><em>responsearray</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">enum <a class="el" href="../../d0/d70/odpapi_8h.html#a0ef5ef162d0b77c52b4f3c17d5b769b2">ODPAPI_ADDSTATUS</a>&#160;</td>
          <td class="paramname"><em>status</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">int&#160;</td>
          <td class="paramname"><em>sequence</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">char *&#160;</td>
          <td class="paramname"><em>id</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">char *&#160;</td>
          <td class="paramname"><em>hint</em>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Creates an Add Response Element. </p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">responsearray</td><td>Pointer to the <a class="el" href="../../db/d68/structcJSON.html">cJSON</a> response array node </td></tr>
  </table>
  </dd>
</dl>

<p>Definition at line <a class="el" href="../../d8/d4f/odpapi_8c_source.html#l00382">382</a> of file <a class="el" href="../../d8/d4f/odpapi_8c_source.html">odpapi.c</a>.</p>

<p>References <a class="el" href="../../dd/d21/cJSON_8c_source.html#l00520">cJSON_AddItemToArray()</a>, <a class="el" href="../../d1/d82/cJSON_8h_source.html#l00133">cJSON_AddNumberToObject</a>, <a class="el" href="../../d1/d82/cJSON_8h_source.html#l00134">cJSON_AddStringToObject</a>, and <a class="el" href="../../dd/d21/cJSON_8c_source.html#l00545">cJSON_CreateObject()</a>.</p>

<p><div class="dynheader">
Here is the call graph for this function:</div>
<div class="dyncontent">
<div class="center"><img src="../../d8/d4f/odpapi_8c_a67aecd120044b4d19aaa28d4be821a01_cgraph.png" border="0" usemap="#d8/d4f/odpapi_8c_a67aecd120044b4d19aaa28d4be821a01_cgraph" alt=""/></div>
<map name="d8/d4f/odpapi_8c_a67aecd120044b4d19aaa28d4be821a01_cgraph" id="d8/d4f/odpapi_8c_a67aecd120044b4d19aaa28d4be821a01_cgraph">
<area shape="rect" id="node2" href="../../dd/d21/cJSON_8c.html#a164dcefd36af8654942116c444bd0b6a" title="cJSON_AddItemToArray" alt="" coords="203,5,365,32"/><area shape="rect" id="node4" href="../../dd/d21/cJSON_8c.html#a9c5f44afdd781b16dead90042fe74085" title="cJSON_CreateObject" alt="" coords="211,56,357,83"/><area shape="rect" id="node3" href="../../dd/d21/cJSON_8c.html#a5d61bcc0045ace88c2ae04f0928eeace" title="suffix_object" alt="" coords="430,5,525,32"/><area shape="rect" id="node5" href="../../dd/d21/cJSON_8c.html#a39a97485cfb9d19bad65a0522faea19f" title="cJSON_New_Item" alt="" coords="414,56,541,83"/></map>
</div>
</p>

</div>
</div>
<a class="anchor" id="a8debbd76bf22a3ce3b7b2d865abed648"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">char* odpapi_format_common_result_text </td>
          <td>(</td>
          <td class="paramtype">char *&#160;</td>
          <td class="paramname"><em>buffer</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">size_t&#160;</td>
          <td class="paramname"><em>length</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">enum <a class="el" href="../../d0/d70/odpapi_8h.html#a173a55e8071a19a0345ead2067182a87">ODPAPI_COMMONERROR</a>&#160;</td>
          <td class="paramname"><em>error</em>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Returns a text representation for a given common error enumeration. </p>
<p>It is recommended that you provide at least 256 bytes of storage for the result area. This function will also return the address of the storage area as a result so that it can be used inline in other fucntions, such as fprintf.</p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">buffer</td><td>The address of the storage buffer to receive the result </td></tr>
    <tr><td class="paramname">length</td><td>The length of the storage buffer to receive the result </td></tr>
    <tr><td class="paramname">error</td><td>The Open Data Protection API common error code value </td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>The address of the storage areacommon error value </dd></dl>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">buffer</td><td>pointer to storage for result </td></tr>
    <tr><td class="paramname">length</td><td>size of storage for result </td></tr>
  </table>
  </dd>
</dl>

<p>Definition at line <a class="el" href="../../d8/d4f/odpapi_8c_source.html#l00014">14</a> of file <a class="el" href="../../d8/d4f/odpapi_8c_source.html">odpapi.c</a>.</p>

<p>References <a class="el" href="../../d0/d70/odpapi_8h_source.html#l00021">ODPAPI_COMMONERROR_ERRORCOMEBACK</a>, <a class="el" href="../../d0/d70/odpapi_8h_source.html#l00022">ODPAPI_COMMONERROR_EXCEEDEDALLOWANCE</a>, <a class="el" href="../../d0/d70/odpapi_8h_source.html#l00020">ODPAPI_COMMONERROR_FAILEDAUTH</a>, <a class="el" href="../../d0/d70/odpapi_8h_source.html#l00023">ODPAPI_COMMONERROR_INVALIDUUID</a>, <a class="el" href="../../d0/d70/odpapi_8h_source.html#l00024">ODPAPI_COMMONERROR_MISSINGARGUMENT</a>, <a class="el" href="../../d0/d70/odpapi_8h_source.html#l00018">ODPAPI_COMMONERROR_NOTOFFERED</a>, <a class="el" href="../../d0/d70/odpapi_8h_source.html#l00019">ODPAPI_COMMONERROR_NOTPERMITTED</a>, <a class="el" href="../../d0/d70/odpapi_8h_source.html#l00016">ODPAPI_COMMONERROR_OK</a>, <a class="el" href="../../d0/d70/odpapi_8h_source.html#l00017">ODPAPI_COMMONERROR_PARSEFAILED</a>, <a class="el" href="../../d0/d70/odpapi_8h_source.html#l00028">ODPAPI_COMMONERROR_SOURCELIBRARYNOTKNOWN</a>, <a class="el" href="../../d0/d70/odpapi_8h_source.html#l00029">ODPAPI_COMMONERROR_TARGETLIBRARYNOTKNOWN</a>, and <a class="el" href="../../d0/d70/odpapi_8h_source.html#l00030">ODPAPI_COMMONERROR_TARGETLIBRARYSAME</a>.</p>

<p>Referenced by <a class="el" href="../../d8/d4f/odpapi_8c_source.html#l00066">odpapi_response_epilog()</a>.</p>

</div>
</div>
<a class="anchor" id="a00ee9474cd43f8889035a3d3289614ee"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void odpapi_inventory_response_helper </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="../../db/d68/structcJSON.html">cJSON</a> *&#160;</td>
          <td class="paramname"><em>responsearray</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">enum <a class="el" href="../../d0/d70/odpapi_8h.html#a0dba2207de5e8ecc9baa3a071e12a622">ODPAPI_INVENTORYSTATUS</a>&#160;</td>
          <td class="paramname"><em>status</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">int&#160;</td>
          <td class="paramname"><em>sequence</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">char *&#160;</td>
          <td class="paramname"><em>id</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">char *&#160;</td>
          <td class="paramname"><em>type</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">char *&#160;</td>
          <td class="paramname"><em>description</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">char *&#160;</td>
          <td class="paramname"><em>movedate</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">int&#160;</td>
          <td class="paramname"><em>encrypted</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">int&#160;</td>
          <td class="paramname"><em>scratch</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">int&#160;</td>
          <td class="paramname"><em>automatemovedate</em>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Creates an Inventory Response Element. </p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">responsearray</td><td>Pointer to the <a class="el" href="../../db/d68/structcJSON.html">cJSON</a> response array node </td></tr>
  </table>
  </dd>
</dl>

<p>Definition at line <a class="el" href="../../d8/d4f/odpapi_8c_source.html#l00252">252</a> of file <a class="el" href="../../d8/d4f/odpapi_8c_source.html">odpapi.c</a>.</p>

<p>References <a class="el" href="../../d1/d82/cJSON_8h_source.html#l00132">cJSON_AddBoolToObject</a>, <a class="el" href="../../dd/d21/cJSON_8c_source.html#l00520">cJSON_AddItemToArray()</a>, <a class="el" href="../../d1/d82/cJSON_8h_source.html#l00133">cJSON_AddNumberToObject</a>, <a class="el" href="../../d1/d82/cJSON_8h_source.html#l00134">cJSON_AddStringToObject</a>, and <a class="el" href="../../dd/d21/cJSON_8c_source.html#l00545">cJSON_CreateObject()</a>.</p>

<p><div class="dynheader">
Here is the call graph for this function:</div>
<div class="dyncontent">
<div class="center"><img src="../../d8/d4f/odpapi_8c_a00ee9474cd43f8889035a3d3289614ee_cgraph.png" border="0" usemap="#d8/d4f/odpapi_8c_a00ee9474cd43f8889035a3d3289614ee_cgraph" alt=""/></div>
<map name="d8/d4f/odpapi_8c_a00ee9474cd43f8889035a3d3289614ee_cgraph" id="d8/d4f/odpapi_8c_a00ee9474cd43f8889035a3d3289614ee_cgraph">
<area shape="rect" id="node2" href="../../dd/d21/cJSON_8c.html#a164dcefd36af8654942116c444bd0b6a" title="cJSON_AddItemToArray" alt="" coords="232,5,395,32"/><area shape="rect" id="node4" href="../../dd/d21/cJSON_8c.html#a9c5f44afdd781b16dead90042fe74085" title="cJSON_CreateObject" alt="" coords="240,56,387,83"/><area shape="rect" id="node3" href="../../dd/d21/cJSON_8c.html#a5d61bcc0045ace88c2ae04f0928eeace" title="suffix_object" alt="" coords="459,5,554,32"/><area shape="rect" id="node5" href="../../dd/d21/cJSON_8c.html#a39a97485cfb9d19bad65a0522faea19f" title="cJSON_New_Item" alt="" coords="443,56,570,83"/></map>
</div>
</p>

</div>
</div>
<a class="anchor" id="affbcad7cbfaba6d69f9943af2ef06a0d"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="../../db/d68/structcJSON.html">cJSON</a>* odpapi_list_response_helper </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="../../db/d68/structcJSON.html">cJSON</a> *&#160;</td>
          <td class="paramname"><em>responsearray</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">int&#160;</td>
          <td class="paramname"><em>sequence</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">char *&#160;</td>
          <td class="paramname"><em>description</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">char *&#160;</td>
          <td class="paramname"><em>guid</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">unsigned int&#160;</td>
          <td class="paramname"><em>capacity</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">unsigned int&#160;</td>
          <td class="paramname"><em>capacityused</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">unsigned int&#160;</td>
          <td class="paramname"><em>movingin</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">unsigned int&#160;</td>
          <td class="paramname"><em>movingout</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">int&#160;</td>
          <td class="paramname"><em>automatemovedate</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">char **&#160;</td>
          <td class="paramname"><em>targetguids</em>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Creates a Library List Response Element. </p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">responsearray</td><td>Pointer to the <a class="el" href="../../db/d68/structcJSON.html">cJSON</a> response array node </td></tr>
  </table>
  </dd>
</dl>

<p>Definition at line <a class="el" href="../../d8/d4f/odpapi_8c_source.html#l00299">299</a> of file <a class="el" href="../../d8/d4f/odpapi_8c_source.html">odpapi.c</a>.</p>

<p>References <a class="el" href="../../d1/d82/cJSON_8h_source.html#l00132">cJSON_AddBoolToObject</a>, <a class="el" href="../../dd/d21/cJSON_8c_source.html#l00520">cJSON_AddItemToArray()</a>, <a class="el" href="../../dd/d21/cJSON_8c_source.html#l00521">cJSON_AddItemToObject()</a>, <a class="el" href="../../d1/d82/cJSON_8h_source.html#l00133">cJSON_AddNumberToObject</a>, <a class="el" href="../../d1/d82/cJSON_8h_source.html#l00134">cJSON_AddStringToObject</a>, <a class="el" href="../../dd/d21/cJSON_8c_source.html#l00544">cJSON_CreateArray()</a>, <a class="el" href="../../dd/d21/cJSON_8c_source.html#l00545">cJSON_CreateObject()</a>, and <a class="el" href="../../dd/d21/cJSON_8c_source.html#l00543">cJSON_CreateString()</a>.</p>

<p><div class="dynheader">
Here is the call graph for this function:</div>
<div class="dyncontent">
<div class="center"><img src="../../d8/d4f/odpapi_8c_affbcad7cbfaba6d69f9943af2ef06a0d_cgraph.png" border="0" usemap="#d8/d4f/odpapi_8c_affbcad7cbfaba6d69f9943af2ef06a0d_cgraph" alt=""/></div>
<map name="d8/d4f/odpapi_8c_affbcad7cbfaba6d69f9943af2ef06a0d_cgraph" id="d8/d4f/odpapi_8c_affbcad7cbfaba6d69f9943af2ef06a0d_cgraph">
<area shape="rect" id="node2" href="../../dd/d21/cJSON_8c.html#a164dcefd36af8654942116c444bd0b6a" title="cJSON_AddItemToArray" alt="" coords="416,5,579,32"/><area shape="rect" id="node4" href="../../dd/d21/cJSON_8c.html#a096004811663311569e95aa77518959c" title="cJSON_AddItemToObject" alt="" coords="197,43,368,69"/><area shape="rect" id="node6" href="../../dd/d21/cJSON_8c.html#a29e5808c66c1cf1f3edbf117babe07b3" title="cJSON_CreateArray" alt="" coords="213,144,352,171"/><area shape="rect" id="node8" href="../../dd/d21/cJSON_8c.html#a9c5f44afdd781b16dead90042fe74085" title="cJSON_CreateObject" alt="" coords="209,195,356,221"/><area shape="rect" id="node9" href="../../dd/d21/cJSON_8c.html#a5987bbc1c94d9f602d719a4015ff0e6c" title="cJSON_CreateString" alt="" coords="211,93,354,120"/><area shape="rect" id="node3" href="../../dd/d21/cJSON_8c.html#a5d61bcc0045ace88c2ae04f0928eeace" title="suffix_object" alt="" coords="627,5,722,32"/><area shape="rect" id="node5" href="../../dd/d21/cJSON_8c.html#a52edadd0bf81e05a1fb04200388475f9" title="cJSON_strdup" alt="" coords="444,81,551,108"/><area shape="rect" id="node7" href="../../dd/d21/cJSON_8c.html#a39a97485cfb9d19bad65a0522faea19f" title="cJSON_New_Item" alt="" coords="434,144,561,171"/></map>
</div>
</p>

</div>
</div>
<a class="anchor" id="a403fda3fa007514b66a723a747a743d4"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void odpapi_move_response_helper </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="../../db/d68/structcJSON.html">cJSON</a> *&#160;</td>
          <td class="paramname"><em>responsearray</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">enum <a class="el" href="../../d0/d70/odpapi_8h.html#a5df3e431080bf9fa4ff8a1f5ec2d2746">ODPAPI_MOVESTATUS</a>&#160;</td>
          <td class="paramname"><em>status</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">int&#160;</td>
          <td class="paramname"><em>sequence</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">char *&#160;</td>
          <td class="paramname"><em>id</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">char *&#160;</td>
          <td class="paramname"><em>type</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">char *&#160;</td>
          <td class="paramname"><em>movedate</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">char *&#160;</td>
          <td class="paramname"><em>hint</em>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Creates a Move Response Element. </p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">responsearray</td><td>Pointer to the <a class="el" href="../../db/d68/structcJSON.html">cJSON</a> response array node </td></tr>
    <tr><td class="paramname">status</td><td>enumeration representing the status of this element </td></tr>
    <tr><td class="paramname">sequence</td><td>index of element (starting at zero) </td></tr>
    <tr><td class="paramname">id</td><td>object id string </td></tr>
    <tr><td class="paramname">movedate</td><td>move_date value in ISO date format </td></tr>
    <tr><td class="paramname">hint</td><td>of any error </td></tr>
  </table>
  </dd>
</dl>

<p>Definition at line <a class="el" href="../../d8/d4f/odpapi_8c_source.html#l00217">217</a> of file <a class="el" href="../../d8/d4f/odpapi_8c_source.html">odpapi.c</a>.</p>

<p>References <a class="el" href="../../dd/d21/cJSON_8c_source.html#l00520">cJSON_AddItemToArray()</a>, <a class="el" href="../../d1/d82/cJSON_8h_source.html#l00133">cJSON_AddNumberToObject</a>, <a class="el" href="../../d1/d82/cJSON_8h_source.html#l00134">cJSON_AddStringToObject</a>, and <a class="el" href="../../dd/d21/cJSON_8c_source.html#l00545">cJSON_CreateObject()</a>.</p>

<p><div class="dynheader">
Here is the call graph for this function:</div>
<div class="dyncontent">
<div class="center"><img src="../../d8/d4f/odpapi_8c_a403fda3fa007514b66a723a747a743d4_cgraph.png" border="0" usemap="#d8/d4f/odpapi_8c_a403fda3fa007514b66a723a747a743d4_cgraph" alt=""/></div>
<map name="d8/d4f/odpapi_8c_a403fda3fa007514b66a723a747a743d4_cgraph" id="d8/d4f/odpapi_8c_a403fda3fa007514b66a723a747a743d4_cgraph">
<area shape="rect" id="node2" href="../../dd/d21/cJSON_8c.html#a164dcefd36af8654942116c444bd0b6a" title="cJSON_AddItemToArray" alt="" coords="211,5,373,32"/><area shape="rect" id="node4" href="../../dd/d21/cJSON_8c.html#a9c5f44afdd781b16dead90042fe74085" title="cJSON_CreateObject" alt="" coords="219,56,365,83"/><area shape="rect" id="node3" href="../../dd/d21/cJSON_8c.html#a5d61bcc0045ace88c2ae04f0928eeace" title="suffix_object" alt="" coords="438,5,533,32"/><area shape="rect" id="node5" href="../../dd/d21/cJSON_8c.html#a39a97485cfb9d19bad65a0522faea19f" title="cJSON_New_Item" alt="" coords="422,56,549,83"/></map>
</div>
</p>

</div>
</div>
<a class="anchor" id="aae7c9c555eb8f8005d5a4432c5066194"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="../../db/d68/structcJSON.html">cJSON</a>* odpapi_request_get_request </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="../../db/d68/structcJSON.html">cJSON</a> *&#160;</td>
          <td class="paramname"><em>root</em></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Finds the request section. </p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">root</td><td>The <a class="el" href="../../db/d68/structcJSON.html">cJSON</a> rootpointer to the <a class="el" href="../../db/d68/structcJSON.html">cJSON</a> request root </td></tr>
  </table>
  </dd>
</dl>

<p>Definition at line <a class="el" href="../../d8/d4f/odpapi_8c_source.html#l00172">172</a> of file <a class="el" href="../../d8/d4f/odpapi_8c_source.html">odpapi.c</a>.</p>

<p>References <a class="el" href="../../d1/d82/cJSON_8h_source.html#l00045">cJSON::child</a>, <a class="el" href="../../d1/d82/cJSON_8h_source.html#l00044">cJSON::next</a>, and <a class="el" href="../../d1/d82/cJSON_8h_source.html#l00053">cJSON::string</a>.</p>

</div>
</div>
<a class="anchor" id="abfb18eac7f57290fe16965746202459e"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="../../db/d68/structcJSON.html">cJSON</a>* odpapi_request_get_value </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="../../db/d68/structcJSON.html">cJSON</a> *&#160;</td>
          <td class="paramname"><em>json</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">char *&#160;</td>
          <td class="paramname"><em>key</em>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Locates a <a class="el" href="../../db/d68/structcJSON.html">cJSON</a> element for a given key. </p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">json</td><td>The <a class="el" href="../../db/d68/structcJSON.html">cJSON</a> branch for search </td></tr>
    <tr><td class="paramname">key</td><td>The key being searched forstring to search for </td></tr>
  </table>
  </dd>
</dl>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">json</td><td>pointer to <a class="el" href="../../db/d68/structcJSON.html">cJSON</a> node </td></tr>
  </table>
  </dd>
</dl>

<p>Definition at line <a class="el" href="../../d8/d4f/odpapi_8c_source.html#l00194">194</a> of file <a class="el" href="../../d8/d4f/odpapi_8c_source.html">odpapi.c</a>.</p>

<p>References <a class="el" href="../../d1/d82/cJSON_8h_source.html#l00045">cJSON::child</a>, <a class="el" href="../../d1/d82/cJSON_8h_source.html#l00044">cJSON::next</a>, and <a class="el" href="../../d1/d82/cJSON_8h_source.html#l00053">cJSON::string</a>.</p>

<p>Referenced by <a class="el" href="../../d8/d4f/odpapi_8c_source.html#l00066">odpapi_response_epilog()</a>.</p>

</div>
</div>
<a class="anchor" id="a41d9d125419e40138d3573c62e9892a7"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void odpapi_response_epilog </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="../../db/d68/structcJSON.html">cJSON</a> *&#160;</td>
          <td class="paramname"><em>root</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">enum <a class="el" href="../../d0/d70/odpapi_8h.html#a173a55e8071a19a0345ead2067182a87">ODPAPI_COMMONERROR</a>&#160;</td>
          <td class="paramname"><em>error</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">char *&#160;</td>
          <td class="paramname"><em>hint</em>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Sets the response section with an integer and string representation of the ODPAPI function result. </p>
<p>This function will look for an existing response section (created by odpapi_response_prolog) and set the result and result_text field to the value passed as the error argument. If a response section can not be found, one will be created.</p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">root</td><td>The <a class="el" href="../../db/d68/structcJSON.html">cJSON</a> root </td></tr>
    <tr><td class="paramname">error</td><td>The error returned by the ODPAPI function </td></tr>
    <tr><td class="paramname">hint</td><td>A string value giving further information on the error (or NULL)error hint text (or NULL) </td></tr>
  </table>
  </dd>
</dl>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">root</td><td>pointer to <a class="el" href="../../db/d68/structcJSON.html">cJSON</a> root </td></tr>
    <tr><td class="paramname">error</td><td>common error value </td></tr>
  </table>
  </dd>
</dl>

<p>Definition at line <a class="el" href="../../d8/d4f/odpapi_8c_source.html#l00066">66</a> of file <a class="el" href="../../d8/d4f/odpapi_8c_source.html">odpapi.c</a>.</p>

<p>References <a class="el" href="../../d1/d82/cJSON_8h_source.html#l00045">cJSON::child</a>, <a class="el" href="../../dd/d21/cJSON_8c_source.html#l00521">cJSON_AddItemToObject()</a>, <a class="el" href="../../d1/d82/cJSON_8h_source.html#l00133">cJSON_AddNumberToObject</a>, <a class="el" href="../../d1/d82/cJSON_8h_source.html#l00134">cJSON_AddStringToObject</a>, <a class="el" href="../../dd/d21/cJSON_8c_source.html#l00545">cJSON_CreateObject()</a>, <a class="el" href="../../d1/d82/cJSON_8h_source.html#l00044">cJSON::next</a>, <a class="el" href="../../d8/d4f/odpapi_8c_source.html#l00014">odpapi_format_common_result_text()</a>, <a class="el" href="../../d8/d4f/odpapi_8c_source.html#l00194">odpapi_request_get_value()</a>, <a class="el" href="../../d1/d82/cJSON_8h_source.html#l00053">cJSON::string</a>, <a class="el" href="../../d1/d82/cJSON_8h_source.html#l00051">cJSON::valuedouble</a>, <a class="el" href="../../d1/d82/cJSON_8h_source.html#l00050">cJSON::valueint</a>, and <a class="el" href="../../d1/d82/cJSON_8h_source.html#l00049">cJSON::valuestring</a>.</p>

<p><div class="dynheader">
Here is the call graph for this function:</div>
<div class="dyncontent">
<div class="center"><img src="../../d8/d4f/odpapi_8c_a41d9d125419e40138d3573c62e9892a7_cgraph.png" border="0" usemap="#d8/d4f/odpapi_8c_a41d9d125419e40138d3573c62e9892a7_cgraph" alt=""/></div>
<map name="d8/d4f/odpapi_8c_a41d9d125419e40138d3573c62e9892a7_cgraph" id="d8/d4f/odpapi_8c_a41d9d125419e40138d3573c62e9892a7_cgraph">
<area shape="rect" id="node2" href="../../dd/d21/cJSON_8c.html#a096004811663311569e95aa77518959c" title="cJSON_AddItemToObject" alt="" coords="216,56,387,83"/><area shape="rect" id="node6" href="../../dd/d21/cJSON_8c.html#a9c5f44afdd781b16dead90042fe74085" title="cJSON_CreateObject" alt="" coords="228,107,375,133"/><area shape="rect" id="node8" href="../../d8/d4f/odpapi_8c.html#a8debbd76bf22a3ce3b7b2d865abed648" title="Returns a text representation for a given common error enumeration." alt="" coords="221,158,381,199"/><area shape="rect" id="node9" href="../../d8/d4f/odpapi_8c.html#abfb18eac7f57290fe16965746202459e" title="Locates a cJSON element for a given key." alt="" coords="234,223,369,265"/><area shape="rect" id="node3" href="../../dd/d21/cJSON_8c.html#a164dcefd36af8654942116c444bd0b6a" title="cJSON_AddItemToArray" alt="" coords="435,5,597,32"/><area shape="rect" id="node5" href="../../dd/d21/cJSON_8c.html#a52edadd0bf81e05a1fb04200388475f9" title="cJSON_strdup" alt="" coords="463,56,569,83"/><area shape="rect" id="node4" href="../../dd/d21/cJSON_8c.html#a5d61bcc0045ace88c2ae04f0928eeace" title="suffix_object" alt="" coords="646,5,741,32"/><area shape="rect" id="node7" href="../../dd/d21/cJSON_8c.html#a39a97485cfb9d19bad65a0522faea19f" title="cJSON_New_Item" alt="" coords="453,107,579,133"/></map>
</div>
</p>

</div>
</div>
<a class="anchor" id="aed8e60a1ba06717416d5141af6ad2bc5"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="../../db/d68/structcJSON.html">cJSON</a>* odpapi_response_prolog </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="../../db/d68/structcJSON.html">cJSON</a> *&#160;</td>
          <td class="paramname"><em>root</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">char *&#160;</td>
          <td class="paramname"><em>adaptername</em>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Initializes <a class="el" href="../../db/d68/structcJSON.html">cJSON</a> control area with meta and response sections. </p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">root</td><td>The <a class="el" href="../../db/d68/structcJSON.html">cJSON</a> root pre-initialized with <a class="el" href="../../dd/d21/cJSON_8c.html#a9c5f44afdd781b16dead90042fe74085">cJSON_CreateObject()</a> </td></tr>
    <tr><td class="paramname">adaptername</td><td>A string representing the name of this ODPAPI adapter adapter name </td></tr>
  </table>
  </dd>
</dl>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">root</td><td>pointer to <a class="el" href="../../db/d68/structcJSON.html">cJSON</a> root </td></tr>
  </table>
  </dd>
</dl>

<p>Definition at line <a class="el" href="../../d8/d4f/odpapi_8c_source.html#l00130">130</a> of file <a class="el" href="../../d8/d4f/odpapi_8c_source.html">odpapi.c</a>.</p>

<p>References <a class="el" href="../../dd/d21/cJSON_8c_source.html#l00521">cJSON_AddItemToObject()</a>, <a class="el" href="../../d1/d82/cJSON_8h_source.html#l00133">cJSON_AddNumberToObject</a>, <a class="el" href="../../d1/d82/cJSON_8h_source.html#l00134">cJSON_AddStringToObject</a>, <a class="el" href="../../dd/d21/cJSON_8c_source.html#l00545">cJSON_CreateObject()</a>, <a class="el" href="../../d0/d70/odpapi_8h_source.html#l00034">ODPAPI_COMMONERROR_UNKNOWN</a>, and <a class="el" href="../../d8/d4f/odpapi_8c_source.html#l00007">ODPAPI_VERSION</a>.</p>

<p><div class="dynheader">
Here is the call graph for this function:</div>
<div class="dyncontent">
<div class="center"><img src="../../d8/d4f/odpapi_8c_aed8e60a1ba06717416d5141af6ad2bc5_cgraph.png" border="0" usemap="#d8/d4f/odpapi_8c_aed8e60a1ba06717416d5141af6ad2bc5_cgraph" alt=""/></div>
<map name="d8/d4f/odpapi_8c_aed8e60a1ba06717416d5141af6ad2bc5_cgraph" id="d8/d4f/odpapi_8c_aed8e60a1ba06717416d5141af6ad2bc5_cgraph">
<area shape="rect" id="node2" href="../../dd/d21/cJSON_8c.html#a096004811663311569e95aa77518959c" title="cJSON_AddItemToObject" alt="" coords="216,56,387,83"/><area shape="rect" id="node6" href="../../dd/d21/cJSON_8c.html#a9c5f44afdd781b16dead90042fe74085" title="cJSON_CreateObject" alt="" coords="228,107,375,133"/><area shape="rect" id="node3" href="../../dd/d21/cJSON_8c.html#a164dcefd36af8654942116c444bd0b6a" title="cJSON_AddItemToArray" alt="" coords="435,5,597,32"/><area shape="rect" id="node5" href="../../dd/d21/cJSON_8c.html#a52edadd0bf81e05a1fb04200388475f9" title="cJSON_strdup" alt="" coords="463,56,569,83"/><area shape="rect" id="node4" href="../../dd/d21/cJSON_8c.html#a5d61bcc0045ace88c2ae04f0928eeace" title="suffix_object" alt="" coords="646,5,741,32"/><area shape="rect" id="node7" href="../../dd/d21/cJSON_8c.html#a39a97485cfb9d19bad65a0522faea19f" title="cJSON_New_Item" alt="" coords="453,107,579,133"/></map>
</div>
</p>

</div>
</div>
<a class="anchor" id="a1ceaab717a211f5c24ddc9f27ddc8987"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void odpapi_scan_response_helper </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="../../db/d68/structcJSON.html">cJSON</a> *&#160;</td>
          <td class="paramname"><em>responsearray</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">enum <a class="el" href="../../d0/d70/odpapi_8h.html#ac158a19a0076dd0108f469e245af0dc2">ODPAPI_SCANSTATUS</a>&#160;</td>
          <td class="paramname"><em>status</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">int&#160;</td>
          <td class="paramname"><em>sequence</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">char *&#160;</td>
          <td class="paramname"><em>id</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">char *&#160;</td>
          <td class="paramname"><em>type</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">char *&#160;</td>
          <td class="paramname"><em>hint</em>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Creates a Scan Response Element. </p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">responsearray</td><td>Pointer to the <a class="el" href="../../db/d68/structcJSON.html">cJSON</a> response array node </td></tr>
  </table>
  </dd>
</dl>

<p>Definition at line <a class="el" href="../../d8/d4f/odpapi_8c_source.html#l00353">353</a> of file <a class="el" href="../../d8/d4f/odpapi_8c_source.html">odpapi.c</a>.</p>

<p>References <a class="el" href="../../dd/d21/cJSON_8c_source.html#l00520">cJSON_AddItemToArray()</a>, <a class="el" href="../../d1/d82/cJSON_8h_source.html#l00133">cJSON_AddNumberToObject</a>, <a class="el" href="../../d1/d82/cJSON_8h_source.html#l00134">cJSON_AddStringToObject</a>, and <a class="el" href="../../dd/d21/cJSON_8c_source.html#l00545">cJSON_CreateObject()</a>.</p>

<p><div class="dynheader">
Here is the call graph for this function:</div>
<div class="dyncontent">
<div class="center"><img src="../../d8/d4f/odpapi_8c_a1ceaab717a211f5c24ddc9f27ddc8987_cgraph.png" border="0" usemap="#d8/d4f/odpapi_8c_a1ceaab717a211f5c24ddc9f27ddc8987_cgraph" alt=""/></div>
<map name="d8/d4f/odpapi_8c_a1ceaab717a211f5c24ddc9f27ddc8987_cgraph" id="d8/d4f/odpapi_8c_a1ceaab717a211f5c24ddc9f27ddc8987_cgraph">
<area shape="rect" id="node2" href="../../dd/d21/cJSON_8c.html#a164dcefd36af8654942116c444bd0b6a" title="cJSON_AddItemToArray" alt="" coords="208,5,371,32"/><area shape="rect" id="node4" href="../../dd/d21/cJSON_8c.html#a9c5f44afdd781b16dead90042fe74085" title="cJSON_CreateObject" alt="" coords="216,56,363,83"/><area shape="rect" id="node3" href="../../dd/d21/cJSON_8c.html#a5d61bcc0045ace88c2ae04f0928eeace" title="suffix_object" alt="" coords="435,5,530,32"/><area shape="rect" id="node5" href="../../dd/d21/cJSON_8c.html#a39a97485cfb9d19bad65a0522faea19f" title="cJSON_New_Item" alt="" coords="419,56,546,83"/></map>
</div>
</p>

</div>
</div>
</div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated on Fri Feb 21 2014 17:13:55 for Open Data Protection C API by &#160;<a href="http://www.doxygen.org/index.html">
<img class="footer" src="../../doxygen.png" alt="doxygen"/>
</a> 1.8.3
</small></address>
</body>
</html>
